curlybars 1.1.4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d425b234907702e06326b091a5dd9bea96d8a5494796e122ee77c56a79dd63ae
-  data.tar.gz: c23f25a52b8c252ebb5aae349c01faefb7daff9e3e8a112e12f676249ad21f23
+  metadata.gz: 7aaafd32b96d9cdf8e9af98ebe3636fc14d4df85761eea4ac804d4b623e1d186
+  data.tar.gz: f177926ffc2cf7c9026a15f6ba7f43089cc9bab4da6e3318ab29a38003f4afdd
 SHA512:
-  metadata.gz: 63657e140e3377cea321adfb20ff4ff1445e1bb00901e49e5f9b095f65b25b6d89cd2ef814e425f9abc7b0ed62d4d003c52459f8f7810943359f9160a9c64b7a
-  data.tar.gz: 077401e926e847f7ee34df7ebce3a0323ae57c9ce6daa8454b67bc6ce6785807cfe96dfcdf406f8a7928f2d2ba992e344d8a7a8581f32c55e3f0459a82dd1f94
+  metadata.gz: 25125dc3e0887ee7878a09f29e96c56f6d863d4aea21cb4c37e226d032cd9b5006c6a512837a9893b95188308d72de426673c8d8815c6d942bdad1ca60032403
+  data.tar.gz: 2cc5791470872a77703979523e3de41a0db3491b8dd453628dc2c68ffe00dbef6374db91feb2da56ddae6edf75d5e6c21c5da3947048a3e320eb67da4d6a10c6

data/lib/curlybars.rb

@@ -28,12 +28,7 @@ module Curlybars
       cache_key = ["Curlybars.compile", identifier, Digest::SHA256.hexdigest(source)]
 
       cache.fetch(cache_key) do
-        transformers = Curlybars.configuration.compiler_transformers
-        transformed_source = transformers.inject(source) do |memo, transformer|
-          transformer.transform(memo, identifier)
-        end
-
-        ast(transformed_source, identifier, run_processors: true).compile
+        ast(transformed_source(source), identifier, run_processors: true).compile
       end
     end
 
@@ -72,6 +67,16 @@ module Curlybars
       errors.empty?
     end
 
+    # Visit nodes in the AST.
+    #
+    # visitor - An instance of a subclass of `Curlybars::Visitor`.
+    # source - The source HBS String used to generate an AST.
+    # identifier - The the file name of the template being checked (defaults to `nil`).
+    def visit(visitor, source, identifier = nil)
+      tree = ast(transformed_source(source), identifier, run_processors: true)
+      visitor.accept(tree)
+    end
+
     def cache
       @cache ||= ActiveSupport::Cache::MemoryStore.new
     end
@@ -80,6 +85,13 @@ module Curlybars
 
     private
 
+    def transformed_source(source)
+      transformers = Curlybars.configuration.compiler_transformers
+      transformers.inject(source) do |memo, transformer|
+        transformer.transform(memo, identifier)
+      end
+    end
+
     def ast(source, identifier, run_processors:)
       tokens = Curlybars::Lexer.lex(source, identifier)
 
@@ -118,3 +130,4 @@ require 'curlybars/template_handler'
 require 'curlybars/railtie' if defined?(Rails)
 require 'curlybars/presenter'
 require 'curlybars/method_whitelist'
+require 'curlybars/visitor'

data/lib/curlybars/version.rb

@@ -1,3 +1,3 @@
 module Curlybars
-  VERSION = '1.1.4'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/lib/curlybars/visitor.rb

@@ -0,0 +1,100 @@
+require 'active_support/core_ext/string/inflections'
+
+module Curlybars
+  class Visitor
+    attr_accessor :context
+
+    def initialize(context)
+      @context = context
+    end
+
+    def accept(node)
+      visit(node)
+      context
+    end
+
+    private
+
+    def visit(node)
+      class_name = node.class.name.to_s
+      return unless class_name.start_with?('Curlybars::Node')
+
+      method_name = class_name.demodulize.underscore
+      send("visit_#{method_name}", node)
+    end
+
+    def visit_block_helper_else(node)
+      node.arguments.each { |arg| visit(arg) }
+      node.options.each { |opt| visit(opt) }
+      visit(node.helper)
+      visit(node.helper_template)
+      visit(node.else_template)
+    end
+
+    def visit_boolean(_node)
+    end
+
+    def visit_each_else(node)
+      visit(node.path)
+      visit(node.each_template)
+      visit(node.else_template)
+    end
+
+    def visit_if_else(node)
+      visit(node.expression)
+      visit(node.if_template)
+      visit(node.else_template)
+    end
+
+    def visit_item(node)
+      visit(node.item)
+    end
+
+    def visit_literal(_node)
+    end
+
+    def visit_option(node)
+      visit(node.expression)
+    end
+
+    def visit_output(node)
+      visit(node.value)
+    end
+
+    def visit_partial(node)
+      visit(node.path)
+    end
+
+    def visit_path(_node)
+    end
+
+    def visit_root(node)
+      visit(node.template)
+    end
+
+    def visit_string(_node)
+    end
+
+    def visit_template(node)
+      node.items.each { |item| visit(item) }
+    end
+
+    def visit_text(_node)
+    end
+
+    def visit_unless_else(node)
+      visit(node.expression)
+      visit(node.unless_template)
+      visit(node.else_template)
+    end
+
+    def visit_variable(_node)
+    end
+
+    def visit_with_else(node)
+      visit(node.path)
+      visit(node.with_template)
+      visit(node.else_template)
+    end
+  end
+end

data/spec/integration/visitor_spec.rb

@@ -0,0 +1,146 @@
+describe "visitor" do
+  let(:source) do
+    <<-HBS
+      {{#print_args_and_options 'first' 'second' key='value'}}
+      {{/print_args_and_options}}
+
+      {{#render_inverse}}
+        fn
+      {{else}}
+        inverse
+        {{@variable}}
+      {{/render_inverse}}
+
+      {{#each foo}}
+        top
+        {{#each bar}}
+          middle
+          {{#each baz}}
+            inner
+          {{else}}
+            inner inverse
+          {{/each}}
+        {{/each}}
+      {{/each}}
+
+      {{#if valid}}
+        if_template
+        {{#if bar}}
+          foo
+        {{else}}
+          qux
+        {{/if}}
+      {{/if}}
+
+      {{#if baz}}
+        qux
+      {{/if}}
+
+      {{> partial}}
+
+      {{user.avatar.url}}
+      {{#with this}}
+        {{user.avatar.url}}
+      {{/with}}
+
+      {{#unless things}}
+        hi
+      {{/unless}}
+    HBS
+  end
+
+  describe ".visit" do
+    it "visits BlockHelperElse nodes" do
+      visitor = counting_visitor_for(Curlybars::Node::BlockHelperElse)
+      output = Curlybars.visit(visitor, source)
+      expect(output).to eq(4)
+    end
+
+    it "visits EachElse nodes" do
+      visitor = counting_visitor_for(Curlybars::Node::EachElse)
+      output = Curlybars.visit(visitor, source)
+      expect(output).to eq(3)
+    end
+
+    it "visits IfElse nodes" do
+      visitor = counting_visitor_for(Curlybars::Node::IfElse)
+      output = Curlybars.visit(visitor, source)
+      expect(output).to eq(3)
+    end
+
+    it "visits Item nodes" do
+      visitor = counting_visitor_for(Curlybars::Node::Item)
+      output = Curlybars.visit(visitor, source)
+      expect(output).to eq(42)
+    end
+
+    it "visits Literal nodes" do
+      visitor = counting_visitor_for(Curlybars::Node::Literal)
+      output = Curlybars.visit(visitor, source)
+      expect(output).to eq(3)
+    end
+
+    it "visits Option nodes" do
+      visitor = counting_visitor_for(Curlybars::Node::Option)
+      output = Curlybars.visit(visitor, source)
+      expect(output).to eq(1)
+    end
+
+    it "visits Partial nodes" do
+      visitor = counting_visitor_for(Curlybars::Node::Partial)
+      output = Curlybars.visit(visitor, source)
+      expect(output).to eq(1)
+    end
+
+    it "visits Path nodes" do
+      visitor = counting_visitor_for(Curlybars::Node::Path)
+      output = Curlybars.visit(visitor, source)
+      expect(output).to eq(13)
+    end
+
+    it "visits Root nodes" do
+      visitor = counting_visitor_for(Curlybars::Node::Root)
+      output = Curlybars.visit(visitor, source)
+      expect(output).to eq(1)
+    end
+
+    it "visits Template nodes" do
+      visitor = counting_visitor_for(Curlybars::Node::Template)
+      output = Curlybars.visit(visitor, source)
+      expect(output).to eq(14)
+    end
+
+    it "visits Text nodes" do
+      visitor = counting_visitor_for(Curlybars::Node::Text)
+      output = Curlybars.visit(visitor, source)
+      expect(output).to eq(28)
+    end
+
+    it "visits UnlessElse nodes" do
+      visitor = counting_visitor_for(Curlybars::Node::UnlessElse)
+      output = Curlybars.visit(visitor, source)
+      expect(output).to eq(1)
+    end
+
+    it "visits Variable nodes" do
+      visitor = counting_visitor_for(Curlybars::Node::Variable)
+      output = Curlybars.visit(visitor, source)
+      expect(output).to eq(1)
+    end
+
+    it "visits WithElse nodes" do
+      visitor = counting_visitor_for(Curlybars::Node::WithElse)
+      output = Curlybars.visit(visitor, source)
+      expect(output).to eq(1)
+    end
+  end
+
+  def counting_visitor_for(klass)
+    Class.new(Curlybars::Visitor) do
+      define_method "visit_#{klass.name.demodulize.underscore}" do |node|
+        self.context += 1
+        super(node)
+      end
+    end.new(0)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: curlybars
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.0
 platform: ruby
 authors:
 - Libo Cannici
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-25 00:00:00.000000000 Z
+date: 2019-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -234,6 +234,7 @@ files:
 - lib/curlybars/safe_buffer.rb
 - lib/curlybars/template_handler.rb
 - lib/curlybars/version.rb
+- lib/curlybars/visitor.rb
 - spec/acceptance/application_layout_spec.rb
 - spec/acceptance/collection_blocks_spec.rb
 - spec/acceptance/global_helper_spec.rb
@@ -270,6 +271,7 @@ files:
 - spec/integration/node/with_spec.rb
 - spec/integration/processor/tilde_spec.rb
 - spec/integration/processors_spec.rb
+- spec/integration/visitor_spec.rb
 homepage: https://github.com/zendesk/curlybars
 licenses:
 - Apache-2.0
@@ -291,7 +293,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Create your views using Handlebars templates!
@@ -312,6 +314,7 @@ test_files:
 - spec/integration/processor/tilde_spec.rb
 - spec/integration/exception_spec.rb
 - spec/integration/processors_spec.rb
+- spec/integration/visitor_spec.rb
 - spec/integration/node/escape_spec.rb
 - spec/integration/node/unless_else_spec.rb
 - spec/integration/node/output_spec.rb