props_template 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b3bde6ce57e684648932f2fc307d1ad885679ee21428b0c7ee66cc31c13ee67
-  data.tar.gz: aa90aea1e4c0950702619b26183647b74f18f5bfd0fb18808ae8c8d347803ed4
+  metadata.gz: f31ca5a3810b9348f75dae05f2b5cb8927faaedf321a4a565914b5760968090c
+  data.tar.gz: 6709d2fc54d81aaf2977158bffc0754089343e7aa8d32d50cbfb01a54a5b289b
 SHA512:
-  metadata.gz: aab15761d3b7edb82d1f2d637a8ca0dcd3ab2241caa74ab75d4e6226c82a5b513308194c670f7ce1d3ab3c6b80d8fd8111332f9bb4705acd3b70ac05564132bc
-  data.tar.gz: d66cc1d55181b2fb948d393fcc4bac96fb91546ca999d1e3c6634b58309f47cf4b036ed1f7ad9671eb9e63e104e48e5c850907a1b6710d8790481f45b4f470d5
+  metadata.gz: 3d3c08391669747b2b3cecfae77e4c47893a1dd887e21ab999a56e7c5e58a3afed3ccdc8147f4bed75fe1c33a3b903975357e00b515e8f445c5f1d1fef9049bc
+  data.tar.gz: da253f3b0d7f903ef0683990e270a1e5f4140c57416d023cce6645ac0156580a66145cc1061cf74d0f2b300d3e8e570d6bc3683d2aa2f88f5427496ddf43fbb3

data/README.md

@@ -5,7 +5,7 @@ support for Russian-Doll caching, layouts, and can be queried by giving the
 root a key path.
 
 [![Build
-Status](https://circleci.com/gh/thoughtbot/props_template.svg?style=shield)](https://circleci.com/gh/thoughtbot/props_template)
+Status](https://github.com/thoughtbot/props_template/actions/workflows/build.yml/badge.svg)](https://github.com/thoughtbot/props_template/actions/workflows/build.yml)
 
 It's fast.
 
@@ -98,7 +98,7 @@ json.posts do
   end
 
   json.paginationPath posts_path
-  json.current pagedPosts.current_page
+  json.current paged_posts.current_page
   json.total @posts.count
 end
 
@@ -131,6 +131,12 @@ json.greetings "hello world"
 
 You can also add a [layout](#layouts).
 
+To generate `index` and `show` templates for a resource, use the generator:
+
+```
+rails g props:views Post title:string body:text
+```
+
 ## API
 
 ### json.set! or json.\<your key here\>
@@ -144,13 +150,13 @@ end
 
 # or
 
-json.authorDetails, with.some_option do
+json.authorDetails(with.some_option) do
   json.firstName 'David'
 end
 
 # or with hash options
 
-json.authorDetails, {...options} do
+json.authorDetails({...options}) do
   json.firstName 'David'
 end
 
@@ -163,7 +169,7 @@ The inline form defines key and value
 | Parameter | Notes |
 | :--- | :--- |
 | key | A json object key|
-| value | A value or an [options][#options] object enabled with [partial](#partials)|
+| value | A value or an [options](#options) object enabled with [partial](#partials)|
 
 ```ruby
 
@@ -268,7 +274,7 @@ class ObjectCollection < SimpleDelegator
 
   def member_by(attr, val)
     find do |ele|
-      ele[attr] == val
+      ele[attr.to_sym] == val
     end
   end
 end
@@ -296,7 +302,7 @@ class ApplicationRecord < ActiveRecord::Base
   end
 
   def self.member_by(attr, value)
-    find_by(Hash[attr, val])
+    find_by(Hash[attr, value])
   end
 end
 ```
@@ -309,6 +315,30 @@ json.array! Post.all do
 end
 ```
 
+#### json.child!
+
+To build an array of heterogeneous elements, call `json.array!` without a
+collection and add each element with `json.child!`:
+
+```ruby
+json.items do
+  json.array! do
+    json.child! do
+      json.title "first"
+    end
+
+    json.child! do
+      json.body "second"
+    end
+  end
+end
+
+# => {"items": [{"title": "first"}, {"body": "second"}]}
+```
+
+`json.child!` can be [dug](#digging) into by index, e.g. `items.1`, but not by
+attribute.
+
 #### **Array core extension**
 
 For convenience, PropsTemplate includes a core\_ext that adds these methods to
@@ -321,7 +351,7 @@ data = [
   {id: 2, name: 'bar'}
 ]
 
-json.posts
+json.posts do
   json.array! data do
     # ...
   end
@@ -337,11 +367,11 @@ may still need to implement `member_by`.
 Returns all deferred nodes used by the [deferment](#deferment) option.
 
 **Note** This is a [SuperglueJS][1] specific functionality and is used in
-`application.json.props` when first running `rails superglue:install:web`
+`application.json.props` when first running `rails g superglue:install`
 
 
 ```ruby
-json.deferred json.deferred!
+json.defers json.deferred!
 
 # => [{url: '/some_url?props_at=outer.inner', path: 'outer.inner', type: 'auto'}]
 ```
@@ -353,10 +383,12 @@ to fetch missing data in a second round trip.
 Returns all fragment nodes used by the [partial fragments](#partial-fragments)
 option.
 
-```ruby json.fragments json.fragments!  ```
+```ruby
+json.fragments json.fragments!
+```
 
 **Note** This is a [SuperglueJS][1] specific functionality and is used in
-`application.json.props` when first running `rails superglue:install:web`
+`application.json.props` when first running `rails g superglue:install`
 
 ## Options
 
@@ -366,13 +398,13 @@ functionality such as Partials, Deferments, and Caching
 The following are equivalent:
 
 ```ruby
-json.post(with.partial('blog_post') 
+json.post(with.partial('blog_post'))
 ```
 
 or 
 
 ```ruby
-json.post(Props::Options.new.partial('blog_post') 
+json.post(Props::Options.new.partial('blog_post'))
 ```
 ### Hash options
 
@@ -388,7 +420,7 @@ end
 ### Partials
 
 Partials are supported. The following will render the file
-`views/posts/_blog_posts.json.props`, and set a local variable `post` assigned
+`views/posts/_blog_post.json.props`, and set a local variable `post` assigned
 with @post, which you can use inside the partial.
 
 ```ruby
@@ -456,12 +488,14 @@ json.profile do
 end
 ```
 
-When using fragments with Arrays, the argument **MUST** be a lamda:
+When using fragments with Arrays, the argument can be a String, a Symbol, or a
+lambda that receives each item and returns the fragment name. Return `nil` to
+skip the fragment for that item:
 
 ```ruby
 require 'props_template/core_ext'
 
-json.array! ['foo', 'bar'], with.partial("footer").fragment(->(x){ x == 'foo'})
+json.array! ['foo', 'bar'], with.partial("footer").fragment(->(x){ "footer_#{x}" })
 ```
 
 ### Caching
@@ -557,6 +591,19 @@ Finally in your `application.json.props`:
 json.defers json.deferred!
 ```
 
+To render every deferred node in place (e.g. for a request that should get
+the full page), call `json.disable_deferments!` before the deferred nodes:
+
+```ruby
+json.disable_deferments!
+
+json.dashboard(with.defer(:auto)) do
+  json.someFancyMetric 42
+end
+
+# => {"dashboard": {"someFancyMetric": 42}}
+```
+
 #### Working with arrays
 The default behavior for deferments is to use the index of the collection to
 identify an element.
@@ -570,8 +617,10 @@ If you wish to use an attribute to identify the element. You must:
 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 [digging](#digging)
+2. Implement `member_by(attr, value)` on the [collection](#jsonarray). This will
+be called by PropsTemplate when [digging](#digging) with a path like
+`posts.id=1`. Note that `attr` is passed as a String and `value` is coerced
+with `to_i`, so only integer attribute values are supported.
 
 For example:
 
@@ -582,7 +631,7 @@ data = [
   {id: 2, name: 'bar'}
 ]
 
-json.posts
+json.posts do
   json.array! data, with.id_key(:some_id) do |item|
     # By using :key, props_template will append `json.some_id item.some_id`
     # automatically
@@ -686,7 +735,7 @@ The above will render:
 ```
 
 ## Layouts
-A single layout is supported. To use, create an `application.json.props` in
+To use a layout, create an `application.json.props` in
 `app/views/layouts`. Here's an example:
 
 ```ruby
@@ -712,6 +761,23 @@ json.flash flash.to_h
 **NOTE** PropsTemplate inverts the usual Rails rendering flow. PropsTemplate
 will render Layout first, then the template when `yield json` is used.
 
+### Partials with layouts
+
+Partials can also be rendered with a layout. The layout is itself a partial:
+
+```ruby
+# app/views/posts/_stream_message.json.props
+json.greeting "Hello world"
+
+json.data do
+  yield
+end
+```
+
+```ruby
+render partial: "comment", layout: "stream_message"
+```
+
 
 ### Layouts in API-only Rails apps
 
@@ -747,7 +813,7 @@ Props::BaseWithExtensions.class_eval do
   # json.second_value "second"
   #
   # -> { "firstValue" => "first", "second_value" => "second" }
-  def key_format(key)
+  def format_key(key)
     key.to_s
   end
 end
@@ -758,7 +824,7 @@ Props::BaseWithExtensions.class_eval do
   # json.second_value "second"
   #
   # -> { "firstValue" => "first", "secondValue" => "second" }
-  def key_format(key)
+  def format_key(key)
     @key_cache ||= {}
     @key_cache[key] ||= key.to_s.camelize(:lower)
     @key_cache[key]
@@ -777,7 +843,7 @@ Props::BaseWithExtensions.class_eval do
   # json.second_value "second"
   #
   # -> { "first_value" => "first", "second_value" => "second" }
-  def key_format(key)
+  def format_key(key)
     @key_cache ||= {}
     @key_cache[key] ||= key.to_s.underscore
     @key_cache[key]

data/lib/generators/props/templates/index.json.props

@@ -0,0 +1,11 @@
+json.<%= js_plural_table_name %> do
+  json.array! @<%= plural_table_name %> do |<%= singular_table_name %>|
+    <%- attributes_list_with_timestamps.each do |attr| -%>
+    json.<%=attr.to_s.camelize(:lower)%> <%= singular_table_name %>.<%=attr%>
+    <%- end -%>
+    json.edit<%=js_singular_table_name(:upper)%>Path edit_<%=singular_table_name%>_path(<%=singular_table_name%>)
+    json.<%=js_singular_table_name%>Path <%=singular_table_name%>_path(<%=singular_table_name%>)
+  end
+end
+
+json.new<%= js_singular_table_name(:upper) %>Path new_<%= singular_table_name %>_path

data/lib/generators/props/templates/show.json.props

@@ -0,0 +1,6 @@
+<%- attributes_list_with_timestamps.each do |attr|-%>
+json.<%=attr.to_s.camelize(:lower)%> @<%= singular_table_name %>.<%=attr%>
+<%- end -%>
+
+json.<%= js_plural_table_name %>Path <%= plural_table_name %>_path
+json.edit<%= js_singular_table_name(:upper) %>Path edit_<%= singular_table_name %>_path(@<%= singular_table_name %>)

data/lib/generators/props/views/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generates PropsTemplate view files (.json.props) for a given resource.
+
+Example:
+    rails generate props:views Post title:string body:text
+
+    This will create:
+        app/views/posts/index.json.props
+        app/views/posts/show.json.props

data/lib/generators/props/views/views_generator.rb

@@ -0,0 +1,64 @@
+require "rails/generators/named_base"
+require "rails/generators/resource_helpers"
+
+module Props
+  module Generators
+    class ViewsGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::ResourceHelpers
+
+      source_root File.expand_path("../templates", __dir__)
+
+      argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+      def create_root_folder
+        path = File.join("app/views", controller_file_path)
+        empty_directory path unless File.directory?(path)
+      end
+
+      def copy_prop_files
+        available_views.each do |view|
+          @action_name = view
+          filename = filename_with_extensions(view)
+          template filename, File.join("app/views", controller_file_path, filename)
+        end
+      end
+
+      protected
+
+      def js_singular_table_name(casing = :lower)
+        singular_table_name.camelize(casing)
+      end
+
+      def js_plural_table_name(casing = :lower)
+        plural_table_name.camelize(casing)
+      end
+
+      def available_views
+        %w[index show]
+      end
+
+      attr_reader :action_name
+
+      def attributes_names
+        [:id] + super
+      end
+
+      def filename_with_extensions(name)
+        [name, :json, :props].join(".")
+      end
+
+
+      def attributes_list_with_timestamps
+        attributes_list(attributes_names + %w[created_at updated_at])
+      end
+
+      def attributes_list(attributes = attributes_names)
+        if self.attributes.any? { |attr| attr.name == "password" && attr.type == :digest }
+          attributes = attributes.reject { |name| %w[password password_confirmation].include? name }
+        end
+
+        attributes
+      end
+    end
+  end
+end

data/lib/props_template/base.rb

@@ -36,7 +36,7 @@ module Props
     end
 
     def format_key(key)
-      key.to_s
+      (::Symbol === key) ? key.name : key.to_s
     end
 
     def set!(key, value = nil)

data/lib/props_template/base_with_extensions.rb

@@ -46,10 +46,6 @@ module Props
       @em = ExtensionManager.new(self, prev_state[1], prev_state[2])
     end
 
-    def format_key(key)
-      key.to_s
-    end
-
     def set!(key, options = {}, &block)
       if !block && options.is_a?(Props::Options)
         options.valid_for_set!

data/lib/props_template/extensions/partial_renderer.rb

@@ -49,9 +49,15 @@ module Props
       partial = partial_opts[:partial]
       template_keys = retrieve_template_keys(partial_opts)
       details = extract_details(partial_opts)
+      lookup_context = @context.lookup_context
 
-      prefixes = partial.include?("/") ? [] : @context.lookup_context.prefixes
-      @context.lookup_context.find_template(partial, prefixes, true, template_keys, details)
+      prefixes = partial.include?("/") ? [] : lookup_context.prefixes
+
+      if lookup_context.respond_to?(:find!)
+        lookup_context.find!(partial, prefixes, true, template_keys, details)
+      else
+        lookup_context.find_template(partial, prefixes, true, template_keys, details)
+      end
     end
 
     def retrieve_template_keys(options)

data/lib/props_template/version.rb

@@ -1,3 +1,3 @@
 module Props
-  VERSION = "1.0.1".freeze
+  VERSION = "1.0.3".freeze
 end

data/lib/props_template.rb

@@ -59,7 +59,11 @@ module Props
         @builder = prev_builder
         @fragment_path = fragment_path
 
-        if found_block
+        # An inline options object, e.g. `json.foo(with.partial("foo"))`, has
+        # no block; its content comes from the options instead.
+        found_inline_options = found_options.is_a?(Props::Options)
+
+        if found_block || found_inline_options
           @builder.item_context = found_item
           set!(key, found_options, &found_block)
         end
@@ -72,8 +76,11 @@ module Props
       @context.render options
     end
 
+    # Relative to the fragment the dig ended in, so the client can graft into
+    # it; the full path when no fragment was crossed.
     def found_path!
-      @found_path[@fragment_path.size..].join(".")
+      fragment_path = @fragment_path || []
+      @found_path[fragment_path.size..].join(".")
     end
 
     def fragment_context!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: props_template
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Johny Ho
@@ -72,6 +72,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- lib/generators/props/templates/index.json.props
+- lib/generators/props/templates/show.json.props
+- lib/generators/props/views/USAGE
+- lib/generators/props/views/views_generator.rb
 - lib/props_template.rb
 - lib/props_template/base.rb
 - lib/props_template/base_with_extensions.rb
@@ -108,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.16
 specification_version: 4
 summary: A fast JSON builder
 test_files: []