breezy 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bdb89b96ab7b57f15c03452a4b837750946635ac
-  data.tar.gz: c87b2f313de0c13f1ba6373850e9b07fe5e1a82d
+  metadata.gz: 8ce62034c621228792d356fbfaa25033f2636132
+  data.tar.gz: 6f29e954b0b7402138e5e2c0f63736f1880c3638
 SHA512:
-  metadata.gz: d1eb1c5bf8d46964e6b79819f8d67e94616f8810b782c69cdccd0508359b43b00ff1ed03ba0e5f301e4a02b91b8a02431821375dc73afb54a913e0b954e99e6d
-  data.tar.gz: a3d62b3e1c163bbe520ad74d7082a0681481a57146b0d6d72baf2da245eb3ed50f4ebab69a4e3f65481710ba38501b9de820d6172ed33df497d2ac6cf08ac24f
+  metadata.gz: a1d54e6480b866bdd8d6bd36d1b31106a78c25c892e6101f7e1aff6a9ec8c703ef40b36555fae584806e1728302e1c01df9dba518a6b39e9eaca988763af0428
+  data.tar.gz: 9bb3e30225f2df6796e35e3e221ddf0509ea334ae98452a79115a27326e2d72d0b7ca7aa8ab72b50389c27e91343e9df2c7735faee27976ecf538d769dfd91c1

data/README.md

@@ -45,12 +45,12 @@ Use the included BreezyTemplates to create your content.
 
 json.heading @greeting
 
-# `defer: true` will no-op the following block on a direct
+# `defer: :auto` will no-op the following block on a direct
 # visit, use null as a standin value, and append additional
 # javascript in the response to fetch only this content node
 # (no-oping other sibiling blocks) and graft it in the right
 # place on the client side.
-json.dashboard(defer: true) do
+json.dashboard(defer: :auto) do
   sleep 10
   json.num_of_views 100
 end
@@ -274,16 +274,28 @@ would become
 ```
 
 ### Deferment
-You can defer rendering of expensive content using the `defer: true` option available in blocks. Behind the scenes BreezyTemplates will no-op the block entirely, replace the value with a `null` as a standin, and append a `Breezy.visit(/somepath?_breezy_filter=keypath.to.node)` to the response. When the client recieves the payload, `breezy:load` will be fired, then the appended `Breezy.visit` will be called to fetch and graft the missing node before firing `breezy:load` a second time.
+You can defer rendering of expensive content using the `defer: :auto` option available in blocks. Behind the scenes BreezyTemplates will no-op the block entirely, replace the value with a `null` as a standin, and append a `Breezy.visit(/somepath?_breezy_filter=keypath.to.node)` to the response. When the client recieves the payload, `breezy:load` will be fired, then the appended `Breezy.visit` will be called to fetch and graft the missing node before firing `breezy:load` a second time.
 
 Usage:
 ```ruby
-json.dashboard(defer: true) do
+json.dashboard(defer: :auto) do
   sleep 10
   json.some_fancy_metric 42
 end
 ```
 
+A manual option is also available:
+
+```ruby
+json.dashboard(defer: :manual) do
+  sleep 10
+  json.some_fancy_metric 42
+end
+```
+If `:manual` is used, Breezy will no-op the block and not append `Breezy.visit` to the payload. Its up to you to use [node filtering](#filtering_nodes) to fetch the node seperately. A common usecase would be tab content that does not load until you click the tab.
+
+
+
 #### Working with arrays
 If you want to defer elements in an array, you should add a key as an option on `array!` to help breezy generate a more specific keypath, otherwise it'll just use the index.
 
@@ -291,7 +303,7 @@ If you want to defer elements in an array, you should add a key as an option on
 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.greet 'hi'
   end
 end

data/lib/breezy/version.rb

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

data/lib/breezy_template/deferment_extension.rb

@@ -0,0 +1,48 @@
+module BreezyTemplate
+  module DefermentExtension
+    ACTIVE_MODES = [:auto, :manual].freeze
+
+    def set!(key, value = BLANK, *args)
+      options = args.first || {}
+      options = _normalize_options(options)
+      if ::Kernel.block_given? && _deferment_enabled?(options)
+        if _deferment_auto?(options)
+          @js.push(_breezy_visit_current(@path))
+        end
+        return _set_value key, nil
+      else
+        super
+      end
+    end
+
+    def _deferment_auto?(options)
+      options[:defer] == :auto
+    end
+
+    def _deferment_enabled?(options)
+      ACTIVE_MODES.include?(options[:defer]) && (@search_path.nil? || @search_path.size == 0)
+    end
+
+    def _set_request_url(request_path)
+      @request_path = request_path
+    end
+
+    def _deferment_options?(options)
+      ::Hash === options && options.key?(:defer)
+    end
+
+    def _mapping_element(element, options)
+      if _deferment_enabled? options
+        if options.has_key? :key
+          id_name = options[:key]
+          id_val = element[id_name]
+          ::Hash[id_name, id_val]
+        else
+          nil
+        end
+      else
+        super
+      end
+    end
+  end
+end

data/lib/breezy_template/dependency_tracker.rb

@@ -0,0 +1,47 @@
+# This was taken from jbuilder
+
+dependency_tracker = false
+
+begin
+  require 'action_view'
+  require 'action_view/dependency_tracker'
+  dependency_tracker = ::ActionView::DependencyTracker
+rescue LoadError
+  begin
+    require 'cache_digests'
+    dependency_tracker = ::CacheDigests::DependencyTracker
+  rescue LoadError
+  end
+end
+
+if dependency_tracker
+  class BreezyTemplate::Template
+    module DependencyTrackerMethods
+      # Matches:
+      #   json.partial! partial: "comments/comment"
+      #   json.comments @post.comments, partial: "comments/comment", as: :comment
+      #   json.array! @posts, partial: "posts/post", as: :post
+      #   = render partial: "account"
+      #
+      INDIRECT_RENDERS = /
+        (?::partial\s*=>|partial:)  # partial: or :partial =>
+        \s*                         # optional whitespace
+        (['"])([^'"]+)\1            # quoted value
+      /x
+
+      def dependencies
+        indirect_dependencies + explicit_dependencies
+      end
+
+      private
+
+      def indirect_dependencies
+        source.scan(INDIRECT_RENDERS).map(&:second)
+      end
+    end
+  end
+
+  ::BreezyTemplate::DependencyTracker = Class.new(dependency_tracker::ERBTracker)
+  ::BreezyTemplate::DependencyTracker.send :include, ::BreezyTemplate::Template::DependencyTrackerMethods
+  dependency_tracker.register_tracker :breezy, ::BreezyTemplate::DependencyTracker
+end

data/lib/breezy_template/digestor.rb

@@ -0,0 +1,30 @@
+require 'action_view'
+require 'action_view/digestor'
+
+module BreezyTemplate
+  module PartialDigestor
+    if ::Rails.version >= '5.0'
+      def _partial_digestor(options)
+        name = options[:name]
+        finder = options[:finder]
+        ::ActionView::Digestor.digest(name: name, finder: finder)
+      end
+    elsif ::Rails.version >= '4.1'
+      def _partial_digestor(options)
+        name = options[:name]
+        finder = options[:finder]
+        ::ActionView::PartialDigestor.new(name: name, finder: finder).digest
+      end
+    elsif ::Rails.version >= '4.0'
+      def _partial_digestor(options={})
+        name = options[:name]
+        finder = options[:finder]
+        ::ActionView::PartialDigestor.new(name, finder.formats.last, finder).digest
+      end
+    else
+      def _partial_digestor(options)
+        options[:name]
+      end
+    end
+  end
+end

data/lib/breezy_template/handler.rb

@@ -0,0 +1,43 @@
+module BreezyTemplate
+  class Handler
+    cattr_accessor :default_format
+    self.default_format = Mime[:js]
+
+    def self.call(template)
+      # this juggling is required to keep line numbers right in the error
+      %{__already_defined = defined?(json); json||=::BreezyTemplate::Template.new(self);json._filter_by_path(breezy_filter) if defined?(breezy_filter); json._set_request_url(request.path);#{template.source}
+        if !(__already_defined && __already_defined != "method")
+        json.merge!({data: json.found! || json.empty! })
+          if defined?(breezy) && breezy
+            breezy.each do |k, v|
+              json.set! k, v
+            end
+          end
+
+          if protect_against_forgery?
+            json.csrf_token form_authenticity_token
+          end
+
+          if ::Breezy.configuration.track_assets.any?
+            json.assets do
+              json.array! (::Breezy.configuration.track_assets || []).map{|assets|
+                asset_path(assets)
+              }
+            end
+          end
+
+          if defined?(breezy_filter) && !!breezy_filter
+            json.action 'graft'
+            json.path breezy_filter
+          end
+
+          if defined?(session) && session
+            session.delete(:breezy_filter)
+          end
+
+          json.target!
+        end
+      }
+    end
+  end
+end

data/lib/breezy_template/partial_extension.rb

@@ -0,0 +1,87 @@
+module BreezyTemplate
+  module PartialExtension
+    def set!(key, value = BLANK, *args)
+      options = args.first || {}
+      options = _normalize_options(options)
+      if args.one? && _partial_options?(options)
+        _set_inline_partial key, value, options
+      else
+        super
+      end
+    end
+
+    def _fragment_name_with_digest(key, options)
+      if options[:partial] && !options[:skip_digest]
+        [key, _partial_digest(options[:partial])]
+      else
+        super
+      end
+    end
+
+    def array!(collection = [], *attributes)
+      options = attributes.first || {}
+      options = _normalize_options(options)
+
+      if attributes.one? && _partial_options?(options)
+        _render_partial_with_options(options.merge(collection: collection))
+      else
+        super
+      end
+    end
+
+    def _partial_options?(options)
+      ::Hash === options && options.key?(:partial)
+    end
+
+    def _partial_digest(partial)
+      lookup_context = @context.lookup_context
+      name = lookup_context.find(partial, lookup_context.prefixes, true).virtual_path
+      _partial_digestor({name: name, finder: lookup_context})
+    end
+
+    def _set_inline_partial(name, object, options)
+      value = if object.nil?
+        []
+      elsif _is_collection?(object)
+        _scope{ _render_partial_with_options options.merge(collection: object) }
+      else
+        locals = {}
+        locals[options[:as]] = object if !_blank?(object) && options.key?(:as)
+        locals.merge!(options[:locals]) if options.key? :locals
+
+        _cache(*options[:cache]) {
+          _scope{ _render_partial options.merge(locals: locals) }
+        }
+      end
+
+      set! name, value
+    end
+
+    def _render_partial(options)
+      options[:locals].merge! json: self
+      @context.render options
+    end
+
+    def _render_partial_with_options(options)
+      ary_opts = options.dup
+      options.reverse_merge! locals: {}
+      options.reverse_merge! ::BreezyTemplate::Template.template_lookup_options
+      as = options[:as]
+
+      if options.key?(:collection)
+        collection = options.delete(:collection)
+        locals = options.delete(:locals)
+
+        ary_opts.delete(:partial)
+        array! collection, ary_opts do |member|
+          member_locals = locals.clone
+          member_locals.merge! collection: collection
+          member_locals.merge! as.to_sym => member if as
+          _render_partial options.merge(locals: member_locals)
+        end
+      else
+        _render_partial options
+      end
+    end
+  end
+end

data/lib/breezy_template/search_extension.rb

@@ -0,0 +1,83 @@
+module BreezyTemplate
+  module SearchExtension
+    def found!
+      found = @found
+      @found = nil
+      @search_path = []
+      found
+    end
+
+    def array!(collection = [], *attributes)
+      original_search_path = @search_path
+      super
+    ensure
+      @search_path = original_search_path
+    end
+
+    def _filter_by_path(search_path)
+      if search_path.is_a? ::String
+        return _filter_by_path(search_path.split('.'))
+      end
+      @search_path = search_path
+    end
+
+    def _prepare_collection_for_map(collection)
+      if @search_path && !@search_path.empty?
+        id_name, id_val = @search_path.first.split('=')
+
+        @search_path = @search_path[1..-1]
+
+        if (defined? ::ActiveRecord) && collection.is_a?(::ActiveRecord::Relation)
+          if id_val
+            id_val = id_val.to_i
+            collection = collection.where(::Hash[id_name, id_val])
+          else
+            index = id_name.to_i
+            collection = collection.offset(index).limit(1)
+          end
+        else
+          if id_val
+            id_val = id_val.to_i
+            found = collection.find do |ele|
+              ele[id_name] == id_val || ele[id_name.to_sym] == id_val
+            end
+          else
+            index = id_name.to_i
+            found = collection[index]
+          end
+
+          collection = [found]
+        end
+      else
+        super
+      end
+    end
+
+    def set!(key, value = BLANK, *args)
+      options = args.first || {}
+      options = _normalize_options(options)
+
+      if ::Kernel.block_given? && @search_path && !@search_path.empty?
+        if key.to_s == @search_path.first
+          original_search_path = @search_path
+          @search_path = original_search_path[1..-1]
+          if @search_path.size == 0
+            @found = if _cache_options?(options)
+              _cache(*options[:cache]) { _scope { yield self } }
+            else
+              _scope { yield self }
+            end
+          else
+            yield self
+          end
+
+          @search_path = original_search_path
+        end
+
+        return _blank
+      else
+        super
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: breezy
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Johny Ho
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-15 00:00:00.000000000 Z
+date: 2017-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-rails
@@ -126,6 +126,12 @@ files:
 - lib/breezy/xhr_redirect.rb
 - lib/breezy/xhr_url_for.rb
 - lib/breezy_template.rb
+- lib/breezy_template/deferment_extension.rb
+- lib/breezy_template/dependency_tracker.rb
+- lib/breezy_template/digestor.rb
+- lib/breezy_template/handler.rb
+- lib/breezy_template/partial_extension.rb
+- lib/breezy_template/search_extension.rb
 - test/blade_helper.rb
 - test/breezy_template_test.rb
 - test/breezy_test.rb