props_template 0.34.0 → 0.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4bda132d64b759a038cef1cef91f33ce8d2b839c6dfc2178f4b878772c60001
-  data.tar.gz: 2774815590c928cd0b3d01a3d043f74b41086b44e9cd9e5d2947b3fbc44aeeab
+  metadata.gz: '01825cc9ebfc4584469c98d5f8e9df4eb8461210b9eb7fce104ff9ed484c2fa0'
+  data.tar.gz: 392c600764ec2c4de0a0d0035c2d7c573e7bc19f071f0e2efd2b6a66d3e862bc
 SHA512:
-  metadata.gz: 34da08613e5545076e112105483fe1c2a6f851a730ffd126f48834bf08103385a31c9bff04190753bbfb1ccc55a631b5014d97f94c02f0bd097964bd3ad125a6
-  data.tar.gz: b0a945bc75fe63b7bc08efc64e7b4de70093ff10c298bb0f5c9f80cf828cc33211553a2bdcc0aed5a0336f7d8a6580e96c126c4c745a8a350b4ec81abf74418b
+  metadata.gz: cb079a592e94c1d85ca7bed68d334e3c39939652473ae9779ca92bd4cf76311fcca9f3e5603da198b5274e55cd49a54120a554c8968a76bea01141228d0d6abc
+  data.tar.gz: 6e3ada0a21fc1f1112bd5d0839d229b3bf673a79e96386af58d0ee6a4cbf5978081b9d1cc2ba84e98ad7a4f24430fa5eb1ecd11d54ae78fdc15e28ab68df23c0

data/README.md

@@ -93,8 +93,7 @@ You can also add a [layout](#layouts).
 
 ### json.set! or json.\<your key here\>
 
-Defines the attribute or structure. All keys are automatically camelized lower
-by default. See [Change Key Format](#change-key-format) to change this behavior.
+Defines the attribute or structure. All keys are not formatted by default. See [Change Key Format](#change-key-format) to change this behavior.
 
 ```ruby
 json.set! :authorDetails, {...options} do
@@ -156,6 +155,33 @@ The difference between the block form and inline form is
   2. The inline form is considered a leaf node, and you can only [search](#traversing)
   for internal nodes.
 
+### json.extract!
+Extracts attributes from object or hash in 1 line
+
+```ruby
+# without extract!
+json.id user.id
+json.email user.email
+json.firstName user.first_name
+
+# with extract!
+json.extract! user, :id, :email, :first_name
+
+# => {"id" => 1, "email" => "email@gmail.com", "first_name" => "user"}
+
+# with extract! with key transformation
+json.extract! user, :id, [:first_name, :firstName], [:last_name, :lastName]
+
+# => {"id" => 1, "firstName" => "user", "lastName" => "last"}
+```
+
+The inline form defines object and attributes
+
+| Parameter | Notes |
+| :--- | :--- |
+| object | An object |
+| attributes | A list of attributes |
+
 ### json.array!
 Generates an array of json objects.
 
@@ -291,7 +317,7 @@ end
 ### Partials
 
 Partials are supported. The following will render the file
-`views/posts/_blog_posts.json.props`, and set a local variable `foo` assigned
+`views/posts/_blog_posts.json.props`, and set a local variable `post` assigned
 with @post, which you can use inside the partial.
 
 ```ruby
@@ -303,6 +329,7 @@ Usage with arrays:
 
 ```ruby
 # The `as:` option is supported when using `array!`
+# Without `as:` option you can use blog_post variable (name is based on partial's name) inside partial
 
 json.posts do
   json.array! @posts, partial: ["posts/blog_post", locals: {foo: 'bar'}, as: 'post'] do
@@ -310,6 +337,35 @@ json.posts do
 end
 ```
 
+Rendering partials without a key is also supported using `json.partial!`, but use
+sparingly! `json.partial!` is not optimized for collection rendering and may
+cause performance problems. Its best used for things like a shared header or footer.
+
+Do:
+
+```ruby
+json.partial! partial: "header", locals: {user: @user} do
+end
+```
+
+or
+
+```ruby
+json.posts do
+  json.array! @posts, partial: ["posts/blog_post", locals: {post: @post}] do
+  end
+end
+```
+
+Do NOT:
+
+```
+@post.each do |post|
+  json.partial! partial: "post", locals: {post: @post} do
+  end
+end
+```
+
 ### Partial Fragments
 **Note** This is a [SuperglueJS][1] specific functionality.
 
@@ -585,15 +641,60 @@ json.flash flash.to_h
 will render Layout first, then the template when `yield json` is used.
 
 ## Change key format
-By default, keys are not formatted. If you want to change this behavior,
-override it in an initializer:
+By default, keys are not formatted. This is intentional. By being explicity with your keys,
+it makes your views quicker and more easily searchable when working in Javascript land.
+
+If you must change this behavior, override it in an initializer and cache the value:
 
 ```ruby
+# default behavior
 Props::BaseWithExtensions.class_eval do
+  # json.firstValue "first"
+  # json.second_value "second"
+  #
+  # -> { "firstValue" => "first", "second_value" => "second" }
   def key_format(key)
     key.to_s
   end
 end
+
+# camelCased behavior
+Props::BaseWithExtensions.class_eval do
+  # json.firstValue "first"
+  # json.second_value "second"
+  #
+  # -> { "firstValue" => "first", "secondValue" => "second" }
+  def key_format(key)
+    @key_cache ||= {}
+    @key_cache[key] ||= key.to_s.camelize(:lower)
+    @key_cache[key]
+  end
+
+  def result!
+    result = super
+    @key_cache = {}
+    result
+  end
+end
+
+# snake_cased behavior
+Props::BaseWithExtensions.class_eval do
+  # json.firstValue "first"
+  # json.second_value "second"
+  #
+  # -> { "first_value" => "first", "second_value" => "second" }
+  def key_format(key)
+    @key_cache ||= {}
+    @key_cache[key] ||= key.to_s.underscore
+    @key_cache[key]
+  end
+
+  def result!
+    result = super
+    @key_cache = {}
+    result
+  end
+end
 ```
 
 ## Escape mode

data/lib/props_template/base.rb

@@ -105,6 +105,32 @@ module Props
       nil
     end
 
+    def partial!(**options)
+      @context.render options
+    end
+
+    # json.id item.id
+    # json.value item.value
+    #
+    # json.extract! item, :id, :value
+    #
+    # with key transformation
+    # json.extract! item, :id, [:first_name, :firstName]
+    def extract!(object, *values)
+      values.each do |value|
+        key, attribute = if value.is_a?(Array)
+          [value[1], value[0]]
+        else
+          [value, value]
+        end
+
+        set!(
+          key,
+          object.is_a?(Hash) ? object.fetch(attribute) : object.public_send(attribute)
+        )
+      end
+    end
+
     def result!
       if @scope.nil?
         @stream.push_object

data/lib/props_template/extensions/partial_renderer.rb

@@ -82,7 +82,7 @@ module Props
       pass_opts[:locals] ||= {}
       pass_opts[:partial] = partial
       pass_opts[:formats] = [:json]
-      pass_opts.delete(:handlers)
+      pass_opts[:handlers] = [:props]
 
       if !(String === partial)
         raise ArgumentError.new(INVALID_PARTIAL_MESSAGE % partial.inspect)
@@ -137,7 +137,7 @@ module Props
 
       partial, rest = [*options[:partial]]
       rest = (rest || {}).clone
-      locals = rest[:locals] || {}
+      locals = (rest[:locals] || {}).clone
       rest[:locals] = locals
 
       if item

data/lib/props_template/version.rb

@@ -1,3 +1,3 @@
 module Props
-  VERSION = "0.34.0".freeze
+  VERSION = "0.36.0".freeze
 end

data/lib/props_template.rb

@@ -22,6 +22,8 @@ module Props
     self.template_lookup_options = {handlers: [:props]}
 
     delegate :result!, :array!,
+      :partial!,
+      :extract!,
       :deferred!,
       :fragments!,
       :set_block_content!,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: props_template
 version: !ruby/object:Gem::Version
-  version: 0.34.0
+  version: 0.36.0
 platform: ruby
 authors:
 - Johny Ho
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-31 00:00:00.000000000 Z
+date: 2024-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport