breezy 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28b02ed9694b5b85d6646507c147c938500ecd7c
-  data.tar.gz: 3d0e115680c7b088dd4ed03376d18bbdfdca392f
+  metadata.gz: bdb89b96ab7b57f15c03452a4b837750946635ac
+  data.tar.gz: c87b2f313de0c13f1ba6373850e9b07fe5e1a82d
 SHA512:
-  metadata.gz: 252ac9b68b92cdfa5ee57e7a49521f6338f54042e3d17d8a34a73de377d4b69f8f680897209e619b6b65a8e6a4b2a9ce715bd67190d12445d4f33bb3accf867c
-  data.tar.gz: 93e38dea643db06c33a8542d116a4baa861c0b2a85f54e12130b6945346f51bc75c76cff45d2bad2588aa813aaef81bd09e4463bc4e45b0b3850ae3dbf8a3ed3
+  metadata.gz: d1eb1c5bf8d46964e6b79819f8d67e94616f8810b782c69cdccd0508359b43b00ff1ed03ba0e5f301e4a02b91b8a02431821375dc73afb54a913e0b954e99e6d
+  data.tar.gz: a3d62b3e1c163bbe520ad74d7082a0681481a57146b0d6d72baf2da245eb3ed50f4ebab69a4e3f65481710ba38501b9de820d6172ed33df497d2ac6cf08ac24f

data/README.md

@@ -90,7 +90,7 @@ App.Views.PostsIndex = function(json) {
 Breezy does not include ReactJS, you'll have to download it seperately and include it in your path. Or just include [react-rails](https://github.com/reactjs/react-rails).
 
 ```
-gem 'breezy', git: 'https://github.com/jho406/Breezy.git'
+gem 'breezy'
 ```
 
 Then use the provided installation generator:

data/lib/breezy/version.rb

@@ -1,3 +1,3 @@
 module Breezy
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/breezy_template.rb

@@ -0,0 +1,320 @@
+require 'jbuilder'
+require 'digest/md5'
+require 'action_view'
+require 'breezy_template/digestor'
+require 'breezy_template/handler'
+require 'breezy_template/partial_extension'
+require 'breezy_template/deferment_extension'
+require 'breezy_template/search_extension'
+
+module BreezyTemplate
+  class Template < ::Jbuilder
+    include PartialDigestor
+
+    prepend PartialExtension
+    prepend SearchExtension
+    prepend DefermentExtension
+
+    class << self
+      attr_accessor :template_lookup_options
+    end
+
+    self.template_lookup_options = { handlers: [:breezy] }
+
+
+    class Digest
+      def initialize(digest)
+        @digest = "Breezy.cache(\"#{digest}\")"
+      end
+
+      def to_json(*)
+        @digest
+      end
+
+      def as_json(*)
+        self
+      end
+
+      def encode_json(*)
+        @digest
+      end
+    end
+
+    def initialize(context, *args)
+      @context = context
+      @js = []
+      @path = []
+      super(*args)
+    end
+
+    def empty!
+      attributes = @attributes
+      @attributes = {}
+      attributes
+    end
+
+    def _breezy_visit_current(path)
+      uri = ::URI.parse(@request_path)
+      qry = ::URI.decode_www_form(uri.query || '') << ["_breezy_filter", path.join('.')]
+      uri.query = ::URI.encode_www_form(qry)
+      "Breezy.visit('#{uri}', {async: true, pushState: false});"
+    end
+
+    def _blank
+      BLANK
+    end
+
+    def method_missing(*args)
+      key = args[0]
+      @path.push(key)
+      if ::Kernel.block_given?
+        args = _args_for_set_with_block(*args)
+        set!(*args, &::Proc.new)
+      else
+        args = _args_for_set(*args)
+        set!(*args)
+      end
+    ensure
+      @path.pop
+    end
+
+    def set!(key, value = BLANK, *args)
+      options = args.first || {}
+      options = _normalize_options(options)
+      return super if !_cache_options?(options) && !_deferment_options?(options)
+
+      result = if ::Kernel.block_given?
+        _ensure_valid_key(key)
+        _cache(*options[:cache]) { _scope { yield self } }
+      elsif ::Jbuilder === value
+        # json.age 32
+        # json.person another_jbuilder
+        # { "age": 32, "person": { ...  }
+        _ensure_valid_key(key)
+        _cache(*options[:cache]) { value.attributes! }
+      else
+        # json.age 32
+        # { "age": 32 }
+        _ensure_valid_key(key)
+        _cache(*options[:cache]) { value }
+      end
+
+      _set_value key, result
+    end
+
+    def child!(options = {})
+      return super(&::Proc.new) if !_cache_options?(options)
+      options = _normalize_options(options)
+
+      @attributes = [] unless ::Array === @attributes
+      @attributes << _cache(*options[:cache]) {
+        _scope { yield self }
+      }
+    end
+
+    def array!(collection = [], *attributes)
+      options = attributes.first || {}
+      options = _normalize_options(options)
+
+      collection = [] if collection.nil?
+      collection = _prepare_collection_for_map(collection)
+      array = if ::Kernel.block_given?
+        _map_collection(collection, options, &::Proc.new)
+      elsif attributes.any?
+        _map_collection(collection, options) { |element| extract! element, *attributes }
+      else
+        collection.to_a
+      end
+
+      merge! array #remove this depednacy
+    end
+
+    def target!
+      js = _breezy_return(@attributes)
+      @js.push(js)
+      "(function(){#{@js.join}})()"
+    end
+
+    private
+      def _merge_values(current_value, updates)
+        # Always use the new values. This is because cached values
+        # are no longer a Ruby object. They are JS values and can't
+        # be merged.
+
+        updates
+      end
+
+      def _prepare_collection_for_map(collection)
+        collection
+      end
+
+      def _args_for_set_with_block(*args)
+        key = args[0]
+        if ::Hash === args[1] && _extended_options?(args[1])
+          options = args[1]
+          [key, BLANK, options]
+        else
+          [key, BLANK]
+        end
+      end
+
+      def _args_for_set(*args)
+        if args.length == 3
+          key, value, options = args
+
+          [key, value, options]
+        elsif args.length == 2 && _extended_options?(args[1])
+          options = args[1]
+          key = args[0]
+
+          [key, BLANK, options]
+        else
+          key, value = args
+
+          [key, value]
+        end
+      end
+
+      def _extended_options?(value)
+        _partial_options?(value) || _cache_options?(value) || _deferment_options?(value)
+      end
+
+      def _mapping_element(element, options)
+        opts = options.dup
+        if opts[:cache]
+          opts[:cache] = opts[:cache].dup
+
+          if ::Array === opts[:cache] && ::Proc === opts[:cache].first
+            key_proc = opts[:cache][0]
+            opts[:cache][0] = key_proc.call(element)
+          end
+        end
+        _cache(*opts[:cache]) {
+          _scope { yield element }
+        }
+      end
+
+      def _map_collection(collection, options)
+        @path.push(nil)
+        collection.map.with_index do |element, i|
+          if options.has_key? :key
+            id_name = options[:key]
+            id_val = element[id_name]
+            @path[-1] = "#{id_name}=#{id_val}"
+          else
+            @path[-1] = i
+          end
+
+          _mapping_element(element, options, &::Proc.new)
+
+        end - [BLANK]
+      ensure
+        @path.pop
+      end
+
+      def _cache_key(key, options={})
+        key = _fragment_name_with_digest(key, options)
+        key = url_for(key).split('://', 2).last if ::Hash === key
+        key = ::ActiveSupport::Cache.expand_cache_key(key, :jbuilder)
+
+        ::Digest::MD5.hexdigest(key.to_s).tap do |digest|
+          _logger.try :debug, "Cache key :#{key} was digested to #{digest}"
+        end
+      end
+
+      def _cache(key=nil, options={})
+        return yield self if !@context.controller.perform_caching || key.nil?
+
+        parent_js = @js
+        key = _cache_key(key, options)
+        @js = []
+
+        blank_or_value = begin
+          ::Rails.cache.fetch(key, options) do
+            result = yield self
+            if result !=BLANK
+              @js << _breezy_set_cache(key, result)
+              @js.join
+            else
+              BLANK
+            end
+          end
+        ensure
+          @js = parent_js
+        end
+
+        if blank_or_value == BLANK
+          BLANK
+        else
+          v = blank_or_value
+          @js.push(v)
+          Digest.new(key)
+        end
+      end
+
+      def _breezy_set_cache(key, value)
+        "Breezy.cache(\"#{key}\", #{_dump(value)});"
+      end
+
+      def _breezy_return(results)
+        "return (#{_dump(results)});"
+      end
+
+      def _dump(value)
+        ::MultiJson.dump(value)
+      end
+
+      def _ensure_valid_key(key)
+        current_value = _blank? ? BLANK : @attributes.fetch(_key(key), BLANK)
+        raise NullError.build(key) if current_value.nil?
+      end
+
+      def _normalize_options(options)
+        options = options.dup
+        key = options[:cache]
+        opts = {}
+        return options if !key
+
+        if ::Array === key && key.length == 2 && ::Hash === key.last
+          return options
+        end
+
+        if options[:partial]
+          opts[:partial] = options[:partial]
+        end
+
+        key = case key
+        when ::Array
+          key
+        when ::Proc
+          key
+        else
+          [key]
+        end
+
+        options[:cache] = [key, opts]
+        options
+      end
+
+      def _fragment_name_with_digest(key, options)
+        if @context.respond_to?(:cache_fragment_name)
+          # Current compatibility, fragment_name_with_digest is private again and cache_fragment_name
+          # should be used instead.
+          @context.cache_fragment_name(key, options)
+        elsif @context.respond_to?(:fragment_name_with_digest)
+          # Backwards compatibility for period of time when fragment_name_with_digest was made public.
+          @context.fragment_name_with_digest(key)
+        else
+          key
+        end
+      end
+
+      def _cache_options?(options)
+        ::Hash === options && options.key?(:cache)
+      end
+
+      def _logger
+        ::ActionView::Base.logger
+      end
+  end
+end

data/test/breezy_template_test.rb

@@ -917,7 +917,7 @@ class BreezyTemplateTest < ActionView::TestCase
 
     result = jbuild(<<-JBUILDER, request: req)
       json.hit do
-        json.hit2 defer: true do
+        json.hit2 defer: :auto do
           json.hit3 do
             json.greeting 'hello world'
           end
@@ -938,6 +938,32 @@ class BreezyTemplateTest < ActionView::TestCase
     assert_equal expected, result
   end
 
+  test "rendering with manual node deferement" do
+    req = action_controller_test_request
+    req.path = '/some_url'
+
+    result = jbuild(<<-JBUILDER, request: req)
+      json.hit do
+        json.hit2 defer: :manual do
+          json.hit3 do
+            json.greeting 'hello world'
+          end
+        end
+      end
+    JBUILDER
+    Rails.cache.clear
+
+    expected = strip_format(<<-JS)
+      (function(){
+        return (
+          {"data":{"hit":{"hit2":null}}}
+        );
+      })()
+    JS
+
+    assert_equal expected, result
+  end
+
   test "rendering with node array deferment" do
     req = action_controller_test_request
     req.path = '/some_url'
@@ -947,7 +973,7 @@ class BreezyTemplateTest < ActionView::TestCase
         json.hit2 do
           data = [{id: 1, name: 'foo'}, {id: 2, name: 'bar'}]
           json.array! data, key: :id do
-            json.greeting defer: true do
+            json.greeting defer: :auto do
               json.gree 'hi'
             end
           end
@@ -973,7 +999,7 @@ class BreezyTemplateTest < ActionView::TestCase
     undef_context_methods :fragment_name_with_digest, :cache_fragment_name
 
     result = jbuild(<<-JBUILDER)
-      json.hello(32, defer: true)
+      json.hello(32, defer: :auto)
     JBUILDER
 
     expected = strip_format(<<-JS)
@@ -988,7 +1014,7 @@ class BreezyTemplateTest < ActionView::TestCase
   test 'deferment is disabled when filtering by keypath' do
     undef_context_methods :fragment_name_with_digest, :cache_fragment_name
     result = jbuild(<<-JBUILDER, breezy_filter: 'hello.world')
-      json.hello defer: true do
+      json.hello defer: :auto do
         json.world 32
       end
     JBUILDER
@@ -1006,8 +1032,8 @@ class BreezyTemplateTest < ActionView::TestCase
   test 'deferment is enabled at the end of a keypath when filtering' do
     undef_context_methods :fragment_name_with_digest, :cache_fragment_name
     result = jbuild(<<-JBUILDER, breezy_filter: 'hello')
-      json.hello defer: true do
-        json.content defer: true do
+      json.hello defer: :auto do
+        json.content defer: :auto do
           json.world 32
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: breezy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Johny Ho
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-05 00:00:00.000000000 Z
+date: 2017-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-rails
@@ -125,6 +125,7 @@ files:
 - lib/breezy/xhr_headers.rb
 - lib/breezy/xhr_redirect.rb
 - lib/breezy/xhr_url_for.rb
+- lib/breezy_template.rb
 - test/blade_helper.rb
 - test/breezy_template_test.rb
 - test/breezy_test.rb