liquid-autoescape 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c0bf2040df4ea502fc17d771d2c13f8bba903f3d
-  data.tar.gz: f0693c899acd50131b6d5d08cf87a42ec2d40c0d
+SHA256:
+  metadata.gz: b397fc9232706426ca91710555a33c98e8db5ce0af23af26fee26cb44cfa4262
+  data.tar.gz: 3edde43e61454a88ff196180681225b5683982864521dbf860c5ded2d7535cca
 SHA512:
-  metadata.gz: 6defce931791a52e5b1f1522671d79b469b31642b3f9f315513cb739ddd8a1fb62245a87c45ccf18e68d239892ea1c54078a6f4f69f6b23553004c4d18e3d788
-  data.tar.gz: 2e469b2abd6a0eec6288268a93ea42cba9d89d33f90f9235b681c144bc03b538905f417c961394d960cd4ba24acf13d91e8ed50b3beb2050f3a7e17ad39c6c48
+  metadata.gz: 7a8c6bd93a198ec3b558d60d14fe22c3ebad9bc42e85fc79f7bf0185104c8626b0530629d0f99a1934c94ccbec59f19ae80fa37a769f57cd794f1d1295c3268f
+  data.tar.gz: 4261aeb4996b91225f316799bb68a914022630830515b5373ce29a53a83775e2532b057ef820e3ccd84ffde52294c37bcdabdf1e3697a9569fbcce8b9d6aa0fd

data/README.md

@@ -7,7 +7,7 @@ referenced within it to be escaped for display in an HTML context.
 
 ## Requirements
 
-* Ruby >= 2.1
+* Ruby >= 2.2
 * Liquid 2 or 3
 
 ## Basic Usage
@@ -163,3 +163,16 @@ end
 Escaped: {{ variable }}
 Not Escaped: {{ variable | skip_escape }}
 ```
+
+Additionally, autoescaping can be selectively disabled within a block when
+running in global mode:
+
+```liquid
+{% assign value = "&" %}
+
+<!-- Renders "&amp;" -->
+{{ value }}
+
+<!-- Renders "&&" -->
+{% autoescape false %}{{ value }}{{ value }}{% endautoescape %}
+```

data/lib/liquid/autoescape/liquid_ext/variable.rb

@@ -20,12 +20,19 @@ module Liquid
     # @param [Liquid::Context] context The variable's rendering context
     # @return [String] The potentially escaped contents of the variable
     def render(context)
-      if !Autoescape.configuration.global? && !context[Autoescape::ENABLED_FLAG]
+      is_global = Autoescape.configuration.global?
+      is_local = context[Autoescape::ENABLED_FLAG]
+
+      if !is_global && !is_local
         return non_escaping_render(context)
       end
 
-      variable = Autoescape::TemplateVariable.from_liquid_variable(self)
-      is_exempt = Autoescape.configuration.exemptions.apply?(variable)
+      if is_global && is_local == false
+        is_exempt = true
+      else
+        variable = Autoescape::TemplateVariable.from_liquid_variable(self)
+        is_exempt = Autoescape.configuration.exemptions.apply?(variable)
+      end
 
       @filters << [:escape, []] unless is_exempt
       output = non_escaping_render(context)

data/lib/liquid/autoescape/tags/autoescape.rb

@@ -11,7 +11,7 @@ module Liquid
       # Any variables that should be exempt from escaping should have the
       # +skip_escape+ filter applied to them.
       #
-      # @example
+      # @example Default usage
       #   {% assign untrusted = "<script>window.reload();</script>" %}
       #   {% assign trusted = "<strong>Text</strong>" %}
       #
@@ -19,19 +19,33 @@ module Liquid
       #     {{ untrusted }}
       #     {{ trusted | skip_escape }}
       #   {% endautoescape %}
+      #
+      # @example Controlling whether escaping is applied
+      #   {% assign value = "&" %}
+      #
+      #   <!-- Renders "&amp;" -->
+      #   {% autoescape true %}{{ value }}{% endautoescape %}
+      #
+      #   <!-- Renders "&" -->
+      #   {% autoescape false %}{{ value }}{% endautoescape %}
       class Autoescape < Block
 
-        def initialize(tag_name, markup, tokens)
-          unless markup.empty?
-            raise SyntaxError, "Syntax Error in 'autoescape' - Valid syntax: {% autoescape %}"
-          end
+        SYNTAX = /^(#{QuotedFragment})?\s+?$/.freeze
+        private_constant :SYNTAX
 
+        def initialize(tag_name, markup, tokens)
           super
+
+          if markup =~ SYNTAX
+            @autoescape_flag = $1
+          elsif !markup.empty?
+            raise SyntaxError, "Syntax Error in 'autoescape' - Valid syntax: {% autoescape [true|false] %}"
+          end
         end
 
         def render(context)
           context.stack do
-            context[ENABLED_FLAG] = true
+            context[ENABLED_FLAG] = @autoescape_flag ? context[@autoescape_flag] : true
             super
           end
         end

data/lib/liquid/autoescape/version.rb

@@ -1,5 +1,5 @@
 module Liquid
   module Autoescape
-    VERSION = "1.0.0".freeze
+    VERSION = "2.0.0".freeze
   end
 end

data/spec/functional/autoescape_tag_spec.rb

@@ -77,8 +77,33 @@ describe "{% autoescape %}" do
     )
   end
 
-  it "raises an error when called with arguments" do
-    invalid = "{% autoescape on %}{% endautoescape %}"
+  it "supports explicit enabling" do
+    verify_template_output(
+      "{% autoescape true %}{{ variable }}{% endautoescape %}",
+      "&",
+      "variable" => "&"
+    )
+  end
+
+  it "supports explicit disabling" do
+    verify_template_output(
+      "{% autoescape false %}{{ variable }}{% endautoescape %}",
+      "&",
+      "variable" => "&"
+    )
+  end
+
+  it "supports reading the autoescaping state from a variable" do
+    verify_template_output(
+      "{% autoescape escape %}{{ variable }}{% endautoescape %}",
+      "&",
+      "escape" => true,
+      "variable" => "&"
+    )
+  end
+
+  it "raises an error when called with multiple arguments" do
+    invalid = "{% autoescape one two %}{% endautoescape %}"
     expect { Liquid::Template.parse(invalid) }.to raise_error(Liquid::SyntaxError)
   end
 
@@ -118,6 +143,14 @@ describe "{% autoescape %}" do
         )
       end
 
+      it "supports opting out of autoescaping within a block" do
+        verify_template_output(
+          "{{ variable }}{% autoescape false %}{{ variable }}{{ variable }}{% endautoescape %}",
+          "&&&",
+          "variable" => "&"
+        )
+      end
+
     end
 
     context "with custom exemptions" do

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.filter_run_when_matching :focus
+end

data/spec/unit/template_variable_spec.rb

@@ -27,7 +27,16 @@ module Liquid
 
       describe ".from_liquid_variable" do
 
-        let(:liquid_variable) { Liquid::Variable.new(variable_name) }
+        let(:liquid_variable) do
+          args = [variable_name]
+
+          if defined?(Liquid::ParseContext)
+            args << Liquid::ParseContext.new
+          end
+
+          Liquid::Variable.new(*args)
+        end
+
         let(:variable_name) { nil }
 
         let(:wrapper) { TemplateVariable.from_liquid_variable(liquid_variable) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: liquid-autoescape
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Within3
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-21 00:00:00.000000000 Z
+date: 2019-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -17,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -121,6 +115,7 @@ files:
 - lib/liquid/autoescape/template_variable.rb
 - lib/liquid/autoescape/version.rb
 - spec/functional/autoescape_tag_spec.rb
+- spec/spec_helper.rb
 - spec/unit/autoescape_spec.rb
 - spec/unit/configuration_spec.rb
 - spec/unit/core_exemptions_spec.rb
@@ -139,19 +134,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Autoescape support for Liquid
 test_files:
+- spec/spec_helper.rb
 - spec/unit/core_exemptions_spec.rb
 - spec/unit/configuration_spec.rb
 - spec/unit/autoescape_spec.rb