props_template 0.13.0 → 0.17.1

data/lib/props_template/extensions/deferment.rb

@@ -34,6 +34,14 @@ module Props
 
       type, rest = options[:defer]
       placeholder = rest[:placeholder]
+      success_action = rest[:success_action]
+      fail_action = rest[:fail_action]
+
+      if type.to_sym == :auto && options[:key]
+        key, val = options[:key]
+        placeholder = {}
+        placeholder[key] = val
+      end
 
       request_path = @base.context.controller.request.fullpath
       path = @base.traveled_path.join('.')
@@ -44,11 +52,17 @@ module Props
 
       uri.query = ::URI.encode_www_form(qry)
 
-      @deferred.push(
+      deferral = {
         url: uri.to_s,
         path: path,
-        type: type.to_s
-      )
+        type: type.to_s,
+      }
+
+      # camelize for JS land
+      deferral[:successAction] = success_action if success_action
+      deferral[:failAction] = fail_action if fail_action
+
+      @deferred.push(deferral)
 
       placeholder
     end

data/lib/props_template/extensions/fragment.rb

@@ -1,14 +1,10 @@
-require 'digest'
-
 module Props
   class Fragment
     attr_reader :fragments
-    attr_accessor :name
 
-    def initialize(base, fragments={})
+    def initialize(base, fragments=[])
       @base = base
       @fragments = fragments
-      @digest = Digest::SHA2.new(256)
     end
 
     def handle(options)
@@ -20,30 +16,10 @@ module Props
         fragment_name = fragment.to_s
         path = @base.traveled_path.join('.')
         @name = fragment_name
-        @fragments[fragment_name] ||= []
-        @fragments[fragment_name].push(path)
-      end
-
-      if fragment == true
-        locals = partial_opts[:locals]
 
-        identity = {}
-        locals
-          .clone
-          .tap{|h| h.delete(:json)}
-          .each do |key, value|
-            if value.respond_to?(:to_global_id)
-              identity[key] = value.to_global_id.to_s
-            else
-              identity[key] = value
-            end
-          end
-
-        path = @base.traveled_path.join('.')
-        fragment_name = @digest.hexdigest("#{partial_name}#{identity.to_json}")
-        @name = fragment_name
-        @fragments[fragment_name] ||= []
-        @fragments[fragment_name].push(path)
+        @fragments.push(
+          { type: fragment_name, partial: partial_name, path: path }
+        )
       end
     end
   end

data/lib/props_template/extensions/partial_renderer.rb

@@ -1,23 +1,56 @@
-require "concurrent/map"
 require 'action_view'
 
 module Props
+  class RenderedTemplate
+    attr_reader :body, :layout, :template
+
+    def initialize(body, layout, template)
+      @body = body
+      @layout = layout
+      @template = template
+    end
+
+    def format
+      template.format
+    end
+  end
+
   class Partialer
+    INVALID_PARTIAL_MESSAGE = "The partial name must be a string, but received (%s)."
+
     def initialize(base, context, builder)
       @context = context
       @builder = builder
       @base = base
     end
 
+    def extract_details(options) # :doc:
+      @context.lookup_context.registered_details.each_with_object({}) do |key, details|
+        value = options[key]
+
+        details[key] = Array(value) if value
+      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)
-        renderer = PartialRenderer.new(@context, partial_opts)
+          .merge(formats: [:json])
+        partial_opts.delete(:handlers)
+        partial = partial_opts[:partial]
+
+        if !(String === partial)
+          raise ArgumentError.new(INVALID_PARTIAL_MESSAGE % (partial.inspect))
+        end
+
+        template_keys = retrieve_template_keys(partial_opts)
+        details = extract_details(partial_opts)
+        template = find_template(partial, template_keys, details)
 
         all_options.map do |opts|
-          opts[:_template] = renderer.template
+          opts[:_template] = template
           opts
         end
       else
@@ -25,6 +58,17 @@ module Props
       end
     end
 
+    def find_template(path, locals, details)
+      prefixes = path.include?(?/) ? [] : @context.lookup_context.prefixes
+      @context.lookup_context.find_template(path, prefixes, true, locals, details)
+    end
+
+    def retrieve_template_keys(options)
+      template_keys = options[:locals].keys
+      template_keys << options[:as] if options[:as]
+      template_keys
+    end
+
     def block_opts_to_render_opts(builder, options)
       partial, pass_opts = [*options[:partial]]
       pass_opts ||= {}
@@ -46,9 +90,20 @@ module Props
 
       renderer.render(template, pass_opts)
     end
+
+    def render(template, options)
+      view = @context
+      instrument(:partial, identifier: template.identifier) do |payload|
+        locals = options[:locals]
+        content = template.render(view, locals)
+
+        payload[:cache_hit] = view.view_renderer.cache_hits[template.virtual_path]
+        build_rendered_template(content, template)
+      end
+    end
   end
 
-  class PartialRenderer < ActionView::AbstractRenderer
+  class PartialRenderer
     OPTION_AS_ERROR_MESSAGE  = "The value (%s) of the option `as` is not a valid Ruby identifier; " \
                                "make sure it starts with lowercase letter, " \
                                "and is followed by any combination of letters, numbers and underscores."
@@ -57,21 +112,6 @@ module Props
 
     INVALID_PARTIAL_MESSAGE = "The partial name must be a string, but received (%s)."
 
-    def self.find_and_add_template(builder, context, all_options)
-      first_opts = all_options[0]
-
-      if first_opts[:partial]
-        partial_opts = block_opts_to_render_opts(builder, first_opts)
-        renderer = new(context, partial_opts)
-
-        all_options.map do |opts|
-          opts[:_template] = renderer.template
-          opts
-        end
-      else
-        all_options
-      end
-    end
 
     def self.raise_invalid_option_as(as)
       raise ArgumentError.new(OPTION_AS_ERROR_MESSAGE % (as))
@@ -81,7 +121,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/
@@ -108,8 +147,7 @@ module Props
         locals[as] = item
 
         if fragment_name = rest[:fragment]
-          fragment_name = Proc === fragment_name ? fragment_name.call(item) : fragment_name.to_s
-          rest[:fragment] = fragment_name
+          rest[:fragment] = fragment_name.to_s
         end
       end
 
@@ -123,7 +161,6 @@ module Props
 
     def initialize(context, options)
       @context = context
-      super(@context.lookup_context)
       @options = options.merge(formats: [:json])
       @options.delete(:handlers)
       @details = extract_details(@options)
@@ -135,7 +172,7 @@ module Props
       end
 
       @path = partial
-      @context_prefix = @lookup_context.prefixes.first
+
       template_keys = retrieve_template_keys(@options)
       @template = find_template(@path, template_keys)
     end
@@ -147,6 +184,19 @@ module Props
     end
 
     private
+      def extract_details(options) # :doc:
+        @context.lookup_context.registered_details.each_with_object({}) do |key, details|
+          value = options[key]
+
+          details[key] = Array(value) if value
+        end
+      end
+
+      def instrument(name, **options) # :doc:
+        ActiveSupport::Notifications.instrument("render_#{name}.action_view", options) do |payload|
+          yield payload
+        end
+      end
 
       def render_partial(template, view, options)
         template ||= @template
@@ -161,17 +211,13 @@ module Props
         end
       end
 
-      # Sets up instance variables needed for rendering a partial. This method
-      # finds the options and details and extracts them. The method also contains
-      # logic that handles the type of object passed in as the partial.
-      #
-      # If +options[:partial]+ is a string, then the <tt>@path</tt> instance variable is
-      # set to that string. Otherwise, the +options[:partial]+ object must
-      # respond to +to_partial_path+ in order to setup the path.
+      def build_rendered_template(content, template, layout = nil)
+        RenderedTemplate.new content, layout, template
+      end
 
       def find_template(path, locals)
-        prefixes = path.include?(?/) ? [] : @lookup_context.prefixes
-        @lookup_context.find_template(path, prefixes, true, locals, @details)
+        prefixes = path.include?(?/) ? [] : @context.lookup_context.prefixes
+        @context.lookup_context.find_template(path, prefixes, true, locals, @details)
       end
 
       def retrieve_template_keys(options)

data/lib/props_template/layout_patch.rb

@@ -18,9 +18,9 @@ module Props
     def render_props_template(view, template, path, locals)
       layout_locals = locals.dup
       layout_locals.delete(:json)
+      layout_locals[:virtual_path_of_template] = template.virtual_path
 
-      layout = resolve_props_layout(path, layout_locals, [formats.first])
-
+      layout = resolve_props_layout(path, layout_locals.keys, [formats.first])
       body = layout.render(view, layout_locals) do |json|
         locals[:json] = json
         template.render(view, locals)

data/lib/props_template/railtie.rb

@@ -10,13 +10,5 @@ module Props
         require 'props_template/layout_patch'
       end
     end
-
-    # if Rails::VERSION::MAJOR >= 4
-    #   generators do |app|
-    #     Rails::Generators.configure! app.config.generators
-    #     Rails::Generators.hidden_namespaces.uniq!
-    #     require 'generators/rails/scaffold_controller_generator'
-    #   end
-    # end
   end
 end

data/lib/props_template/searcher.rb

@@ -23,9 +23,6 @@ module Props
       []
     end
 
-    def fragment_digest!
-    end
-
     def found!
       pass_opts = @found_options.clone || {}
       pass_opts.delete(:defer)

data/spec/layout_spec.rb

@@ -1,16 +1,24 @@
-require_relative './support/helper'
-require_relative './support/rails_helper'
-require 'props_template/layout_patch'
+require_relative "./support/helper"
+require_relative "./support/rails_helper"
+require "props_template/layout_patch"
+require "action_controller"
 
-RSpec.describe 'Props::Template' do
-  it 'uses a layout to render' do
-    view_path = File.join(File.dirname(__FILE__),'./fixtures')
-    controller = ActionView::TestCase::TestController.new
+RSpec.describe "Props::Template" do
+  class TestController < ActionController::Base
+    protect_from_forgery
+
+    def self.controller_path
+      ""
+    end
+  end
+
+  it "uses a layout to render" do
+    view_path = File.join(File.dirname(__FILE__), "./fixtures")
+    controller = TestController.new
     controller.prepend_view_path(view_path)
-    controller.response.headers['Content-Type']='application/json'
-    controller.request.path = '/some_url'
 
-    json = controller.render('200', layout: 'application')
+    json = controller.render_to_string("200", layout: "application")
+
     expect(json.strip).to eql('{"data":{"success":"ok"}}')
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: props_template
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.17.1
 platform: ruby
 authors:
 - Johny Ho
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-20 00:00:00.000000000 Z
+date: 2021-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,30 +52,18 @@ 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: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/props_template.rb
 - lib/props_template/base.rb
 - lib/props_template/base_with_extensions.rb
 - lib/props_template/core_ext.rb
+- lib/props_template/debug_writer.rb
 - lib/props_template/dependency_tracker.rb
 - lib/props_template/extension_manager.rb
 - lib/props_template/extensions/cache.rb
@@ -83,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
@@ -94,7 +81,7 @@ homepage: https://github.com/jho406/breezy/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -109,8 +96,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: A JSON builder for your React props
 test_files:

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