props_template 0.35.0 → 0.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8400f382bf1e777d3b2a863228bfec9486388f1f3ef77e127cbc1220a9917e32
-  data.tar.gz: 5847aae3d52a018f4c31e437a46147882da8c6cf35d38bc282fb068bc4b3b678
+  metadata.gz: ecdcee486c14966bbb3259a5b213631b3cd29f14a31a7194a8e9aad1ade31398
+  data.tar.gz: c33d2129e1aa5ba580003c834f828bc48c820120e4ffa66f9eebfc1531fed7a0
 SHA512:
-  metadata.gz: d730232224bfea323784f896dd51f4f00025cf922ee5e5791e767520b852b0af8b717bd787183cd02a30a985ee9821d8b19eddf362adf64225d2959ca22dfa9f
-  data.tar.gz: 29c1a6a96ebc9fca218d7aaea1064d5b916e494dae534c11b0572c06f8d1543b8c0f5c651d1df00144fa372546a6992058d9c73dd810a8d57c78bacc2e078fb1
+  metadata.gz: 6f11a45290e1c10aa7b526506f305b723928e8414117a6aac637dbdbd95d09ae414cb18ff5c8d74a249cf12bf85f55af5d2d9f83f7846c2c03690fde5d4990bc
+  data.tar.gz: bc476b0780f7448883bd7dfe8316ac837c851d7255420eeb8496730285d68404b64dcf94a45e856acbaefa9788c76d7f1b70722a61316129e9751a16250e8d7c

data/README.md

@@ -72,7 +72,7 @@ gem 'props_template'
 and run `bundle`.
 
 Optionally add the [core ext](#array-core-extension) to an initializer if you
-want to [dig](#traversing) into your templates.
+want to [dig](#digging) into your templates.
 
 ```ruby
 require 'props_template/core_ext'
@@ -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
@@ -153,9 +152,36 @@ The difference between the block form and inline form is
   1. The block form is an internal node. Functionality such as Partials,
   Deferment and other [options](#options) are only available on the
   block form.
-  2. The inline form is considered a leaf node, and you can only [search](#traversing)
+  2. The inline form is considered a leaf node, and you can only [dig](#digging)
   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.
 
@@ -176,7 +202,7 @@ end
 | collection | A collection that responds to `member_at` and `member_by` |
 | options | Additional [options](#options)|
 
-To support [traversing nodes](#traversing), any list passed
+To support [digging](#digging), any list passed
 to `array!` MUST implement `member_at(index)` and `member_by(attr, value)`.
 
 For example, if you were using a delegate:
@@ -250,7 +276,7 @@ end
 ```
 
 PropsTemplate does not know what the elements are in your collection. The
-example above will be fine for [traversing](#traversing)
+example above will be fine for [digging](#digging)
 by index, but will raise a `NotImplementedError` if you query by attribute. You
 may still need to implement `member_by`.
 
@@ -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.
 
@@ -391,7 +447,7 @@ entirely and replace the value with a placeholder. A common use case would be
 tabbed content that does not load until you click the tab.
 
 When your client receives the payload, you may issue a second request to the
-same endpoint to fetch any missing nodes. See [traversing nodes](#traversing)
+same endpoint to fetch any missing nodes. See [digging](#digging)
 
 There is also an `defer: :auto` option that you can use with [SuperglueJS][1]. [SuperglueJS][1]
 will use the metadata from `json.deferred!` to issue a `remote` dispatch to fetch
@@ -446,7 +502,7 @@ your collection item, and is used for `defer: :auto` to generate a keypath for
 [SuperglueJS][1]. If you are NOT using SuperglueJS, you do not need to do this.
 
 2. Implement `member_at`, on the [collection](#jsonarray). This will be called
-by PropsTemplate to when [searching nodes](#traversing)
+by PropsTemplate to when [digging](#digging)
 
 For example:
 
@@ -472,7 +528,7 @@ end
 If you are using [SuperglueJS][1], SuperglueJS will, it will automatically kick off
 `remote(?props_at=posts.some_id=1.contact)` and `remote(?props_at=posts.some_id=2.contact)`.
 
-## Traversing
+## Digging
 
 PropsTemplate has the ability to walk the tree you build, skipping execution of
 untargeted nodes. This feature is useful for selectively updating your frontend
@@ -481,7 +537,7 @@ state.
 ```ruby
 traversal_path = ['data', 'details', 'personal']
 
-json.data(search: traversal_path) do
+json.data(dig: traversal_path) do
   json.details do
     json.employment do
       ...more stuff
@@ -515,13 +571,13 @@ The above will output:
 }
 ```
 
-Searching only works with blocks, and will NOT work with Scalars
+Digging only works with blocks, and will NOT work with Scalars
 ("leaf" values). For example:
 
 ```ruby
 traversal_path = ['data', 'details', 'personal', 'name'] <- not found
 
-json.data(search: traversal_path) do
+json.data(dig: traversal_path) do
   json.details do
     json.personal do
       json.name 'james'
@@ -532,12 +588,12 @@ end
 
 ## Nodes that do not exist
 
-Nodes that are not found will remove the branch where search was enabled on.
+Nodes that are not found will remove the branch where digging was enabled on.
 
 ```ruby
 traversal_path = ['data', 'details', 'does_not_exist']
 
-json.data(search: traversal_path) do
+json.data(dig: traversal_path) do
   json.details do
     json.personal do
       json.name 'james'
@@ -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 diggable 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)

data/lib/props_template/version.rb

@@ -1,3 +1,3 @@
 module Props
-  VERSION = "0.35.0".freeze
+  VERSION = "0.37.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!,
@@ -34,11 +36,15 @@ module Props
     end
 
     def set!(key, options = {}, &block)
-      if block && options[:search] && !@builder.is_a?(Searcher)
+      if block && (options[:search] || options[:dig]) && !@builder.is_a?(Searcher)
+        search = options[:search] || options[:dig]
 
         prev_builder = @builder
-        @builder = Searcher.new(self, options[:search], @context)
+        @builder = Searcher.new(self, search, @context)
+
         options.delete(:search)
+        options.delete(:dig)
+
         @builder.set!(key, options, &block)
         found_block, found_options = @builder.found!
         @builder = prev_builder

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: props_template
 version: !ruby/object:Gem::Version
-  version: 0.35.0
+  version: 0.37.0
 platform: ruby
 authors:
 - Johny Ho
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-20 00:00:00.000000000 Z
+date: 2024-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,40 +15,52 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
 description: PropsTemplate is a direct-to-Oj, JBuilder-like DSL for building JSON.
@@ -80,7 +91,6 @@ homepage: https://github.com/thoughtbot/props_template/
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -95,8 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A fast JSON builder
 test_files: []