props_template 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a54115d5cb581b3b4a3c487ca6bdad66a2f533a56f1171d65c9f1759ca9f2ec
-  data.tar.gz: d7672f8b3324ec7ae2b63e790b2c0f38e73f3b5534ad18a5e8a1704bd14c98b2
+  metadata.gz: 4b2f7cf3a4eca0bead0971f22d1f75de65d3e365c2684d9055b80c6310b07df3
+  data.tar.gz: bd190fb9a3581b9f056eef6512f2ad6c7331b03f033553a4c236dc10effcac76
 SHA512:
-  metadata.gz: d07608d99ad469d3dfe6c4f264b7addb844b7a35f6a5ce2c13469bd1bd1dfa14d41c6800f62933a122d86d3ecf65a08aba95a4746d3fc329b5daf1305ec288af
-  data.tar.gz: b76b141b1938ebc83b40c2208c0d77274472c02615a17a0a6771147b38ac7639923b092b066333708087f2074b920e06d99e824b4b36fc9a8e4d517afb7d3f3a
+  metadata.gz: 421bcf7b29a5f7ce4a21ce99a39db7b243f86eac63ae3cdb6d513745cd91f2bd830a72c360826048a7fafd03dff293bcc4024311e053f9a330a5880212c0439e
+  data.tar.gz: 4efdc30e4b36fdc382b75936625b7ae233ea065bf7c1f632e2e943730c28ea8f9b4e3b8d58a28a788d67102995948b7fffac61042b9ce4479e068435e952d935

data/lib/props_template/base.rb

@@ -1,5 +1,6 @@
 require "oj"
 require "active_support"
+require "props_template/raw_json"
 
 module Props
   class InvalidScopeForArrayError < StandardError; end
@@ -11,8 +12,10 @@ module Props
   class Base
     attr_accessor :item_context
 
+    WRITER_OPTIONS = {mode: :rails, use_raw_json: true}.freeze
+
     def initialize(encoder = nil)
-      @stream = Oj::StringWriter.new(mode: :rails)
+      @stream = Oj::StringWriter.new(WRITER_OPTIONS)
       @scope = nil
       @item_context = nil
     end
@@ -170,13 +173,18 @@ module Props
 
     def capture_json
       parent_stream = @stream
-      @stream = Oj::StringWriter.new(mode: :rails)
+      @stream = Oj::StringWriter.new(WRITER_OPTIONS)
       yield
       @stream.raw_json.strip
     ensure
       @stream = parent_stream
     end
 
+    # Adds already-encoded JSON, such as a cached fragment, as the next value.
+    def push_cached_json(json)
+      @stream.push_value(RawJSON.new(json))
+    end
+
     def result!
       if @scope.nil?
         @stream.push_object

data/lib/props_template/extension_manager.rb

@@ -1,5 +1,9 @@
 module Props
   class ExtensionManager
+    # A cached fragment is stored after a line of the deferred and fragment
+    # paths inside it, which is this when there are none.
+    EMPTY_META_LINE = "[[],[]]\n".freeze
+
     attr_reader :base, :builder, :context, :cache, :partialer
 
     delegate :load_cache, to: :cache
@@ -69,7 +73,7 @@ module Props
     private
 
     def handle_cache(options, item)
-      if options[:cache]
+      if options[:cache] && @cache.enabled?
         key, rest = Cache
           .normalize_options(options[:cache], item)
 
@@ -85,12 +89,19 @@ module Props
           result
         end
 
-        meta, raw_json = state.split("\n", 2)
-        next_deferred, next_fragments = Oj.load(meta)
-        deferred.push(*next_deferred)
-        fragments.push(*next_fragments)
+        # Nearly every fragment has no deferred or fragment paths, so the
+        # empty line is skipped without being split off or parsed.
+        if state.start_with?(EMPTY_META_LINE)
+          raw_json = state.byteslice(EMPTY_META_LINE.bytesize..)
+        else
+          separator = state.byteindex("\n")
+          next_deferred, next_fragments = Oj.load(state.byteslice(0, separator))
+          deferred.push(*next_deferred)
+          fragments.push(*next_fragments)
+          raw_json = state.byteslice((separator + 1)..)
+        end
 
-        base.stream.push_json(raw_json)
+        base.stream.push_value(RawJSON.new(raw_json))
       else
         yield
       end

data/lib/props_template/extensions/cache.rb

@@ -56,15 +56,21 @@ module Props
       result
     end
 
+    def enabled?
+      controller.perform_caching
+    end
+
     def load_cache(keys, options = {})
-      @results = results.merge multi_fetch(keys, options)
+      if enabled?
+        @results = results.merge multi_fetch(keys, options)
+      end
     end
 
     # 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
+      if enabled?
         cache_fragment_for(key, options) do
           yield
         end

data/lib/props_template/raw_json.rb

@@ -0,0 +1,15 @@
+module Props
+  # Already-encoded JSON, such as a cached fragment, for Oj to insert as is.
+  # Oj calls raw_json on values when its use_raw_json option is on, and
+  # takes the length from the String rather than scanning for it as
+  # push_json does.
+  class RawJSON
+    def initialize(json)
+      @json = json
+    end
+
+    def raw_json(depth, indent)
+      @json
+    end
+  end
+end

data/lib/props_template/version.rb

@@ -1,3 +1,3 @@
 module Props
-  VERSION = "1.1.1".freeze
+  VERSION = "1.2.0".freeze
 end

data/lib/props_template.rb

@@ -17,6 +17,12 @@ require "active_support"
 
 module Props
   class Template
+    GENERATED_KEY_METHODS = Module.new
+    include GENERATED_KEY_METHODS
+
+    GENERATABLE_KEY_REGEXP = /\A[a-zA-Z_]\w*[!?]?\z/
+    GENERATED_KEY_METHODS_LOCK = Mutex.new
+
     class << self
       attr_accessor :template_lookup_options
     end
@@ -93,8 +99,30 @@ module Props
       @builder
     end
 
-    alias_method :method_missing, :set!
-    private :method_missing
+    def self.generate_key_method(key)
+      GENERATED_KEY_METHODS_LOCK.synchronize do
+        name = key.name
+        already_implemented = method_defined?(key) || private_method_defined?(key)
+
+        if !already_implemented && GENERATABLE_KEY_REGEXP.match?(name)
+          GENERATED_KEY_METHODS.module_eval <<~RUBY, __FILE__, __LINE__ + 1
+            def #{name}(options = {}, &block)
+              set!(#{key.inspect}, options, &block)
+            end
+          RUBY
+        end
+      end
+    end
+
+    private
+
+    # No respond_to_missing?: a builder accepts any key, but claiming to
+    # respond to everything would answer yes to probes like to_ary or to_hash.
+    # Generated methods are real methods, so respond_to? sees those already.
+    def method_missing(key, ...) # standard:disable Style/MissingRespondToMissing
+      self.class.generate_key_method(key)
+      set!(key, ...)
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: props_template
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Johny Ho
@@ -92,6 +92,7 @@ files:
 - lib/props_template/options.rb
 - lib/props_template/partial_patch.rb
 - lib/props_template/railtie.rb
+- lib/props_template/raw_json.rb
 - lib/props_template/searcher.rb
 - lib/props_template/version.rb
 homepage: https://github.com/thoughtbot/props_template/